home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / AMICUS / AMICUS14.ADF / Text / IconText.DOC < prev    next >
Text File  |  1989-01-28  |  6KB  |  148 lines
  1. One Way of Organizing Release Diskette:
  2.  
  3. I had intended to publish this earlier but haven't gotten around to it 
  4. til now.  THIS IS NOT AN OFFICIAL COMMODORE-AMIGA RECOMMENDATION.  It 
  5. is intended as "food for thought" and a starting place for your product 
  6. release format.  Please feel free to discuss this and other methods. 
  7. Placing items in the .info tooltypes fields is another way that may help. 
  8. Written 8:03 pm  May 21, 1986  by Bruce Barrett
  9.  
  10.  
  11. Proposal for standard Tool, tool support, and project access. 
  12.  
  13. Background: 
  14.  
  15.    Textcraft, and possibly other utilities have "solved" the  
  16. problem of "where are my support files" by making reference to "SYS:". 
  17. This works well if you boot Textcraft as your system diskette but fails 
  18. if you boot a "standard" workbench diskette.  It will also fail if you 
  19. move Textcraft into a subdirectory of a hard disk.  In all fairness it 
  20. was inevitable that one of the first few tools point out this problem.  
  21. The following suggested ground rules are an attempt to fix this problem. 
  22.  
  23. "OK" assumptions on the part of the program/developer: 
  24.  
  25.     o   Support files/drawers will be available in the same directory 
  26.         as the tool 
  27.     o   Support file and drawer names will not be changed by the user. 
  28.  
  29. "NOT OK" assumptions on the part of the program/developer: 
  30.  
  31.     o   The tool will reside on a specific volume (name). 
  32.     o   The tool will not be renamed. 
  33.     o   The name of the workbench diskette is "Workbench" 
  34.     o   The tool will reside on the WB boot diskette (sys:) 
  35.  
  36.  
  37.  
  38. Ground Rules: 
  39.  
  40. 1. All files required for a tool to run need to be in a 
  41.    drawer/subdirectory that is in the same directory as 
  42.    the tool itself. 
  43.  
  44. 2. Optional support items (tutorials, demos, fonts, drivers, tables,...) 
  45.    will all have icons (either single files or <empty looking>  
  46.    drawers) containing all the support files.  This allows the user 
  47.    to delete unneeded support material on their COPY of the master  
  48.    diskette. 
  49.  
  50. 3. If all files, or some group of files are necessary they should be 
  51.    placed in a "padlocked" drawer (or file icon), and made  
  52.    "undeletable". 
  53.     
  54. 4. Application should not depend on specific volume names. 
  55.  
  56. 5. New documents will go in project or tool directories.  If the tool 
  57.    was opened with a project it goes in the same drawer as the 
  58.    project.  If a tool was opened "directly" new projects will  
  59.    go in the same disk/drawer as the tool. 
  60.  
  61. 6. Whenever a new project is created, or an old one changed and saved 
  62.    one of the following must be done. 
  63.  
  64.    1) If the file type matches your tool (as in a Textcraft file 
  65.       being rewritten by Textcraft) then: The name of the default  
  66.       tool will be updated to match the current location (AND name)  
  67.       of the tool.  Moving and renaming tools causes semi-automatic  
  68.       updating of default tool names for projects.  This does  
  69.       require 1 extended selection (then save) of project and tool  
  70.       per project. 
  71.  
  72.    2) If the file type does not match your tool (as in a spelling 
  73.       checker "fixing" a Textcraft file) the name and location of  
  74.       the default tool for a project shall not be changed.  The  
  75.       user still has explicit control over the default tool by  
  76.       using the info command.  More than 1 tool can be used on a  
  77.       single project without affecting the default tool. 
  78.  
  79. 7. Tools should not reference SYS:, L:, DEV:, C:, S:, FONTS:, or LIBS: 
  80.    for their own files.  If for some reason they need to copy 
  81.    something into one of these directories an installation 
  82.    program should be provided, AND the documentation should 
  83.    explain that this is going on and what files are being  
  84.    transferred. 
  85.  
  86. 8. If a tool cannot find its required support files it should: 
  87.  
  88.    a) Put up a requester asking the user for the location 
  89.       of the files it needs.  (Preferred) 
  90.    b) Print a message and continue (crippled).  (second best) 
  91.    c) Display a message/requester to this effect and exit. 
  92.     
  93. 9. Tools should not reference hard coded drive names (DF0:, DF1,...). 
  94.     
  95. 10. If you discover that the tool and project are on the same drive 
  96.    when updating the default tool name (as in 6.2 above) change 
  97.    the name to :sub1/sub2/tool, not Vol_name:sub1/sub2/tool. 
  98.  
  99. ================================================================== 
  100.  
  101. Textcraft Example: 
  102.  
  103.    Volume name:      Textcraft 
  104.  
  105.    Files in "root":   Textcraft & info (executable) 
  106.             Textcraft512 & info 
  107.             TC Support (note, new drawer name) 
  108.             Read Me For News & info 
  109.  
  110.    Files in "TC Support":       Std Documents (locked drawer) 
  111.                 Tutorial Files (locked drawer) 
  112.                 Textcraft Setup (TC Prefs, no info) 
  113.  
  114. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
  115.  
  116.    The Read Me For News file will have as its default tool 
  117.    "Textcraft:Textcraft".  Any new documents (originally) 
  118.    will also have as their default tool "Textcraft:Textcraft" 
  119.     
  120. 1)   If the diskette were to be renamed "Letters" the following 
  121.      would occur: 
  122.  
  123.      Double clicking documents will work as before.
  124.  
  125. 2)   If Textcraft were renamed to "My_WP" the message: 
  126.  
  127.      "Cannot open :Textcraft.  Error 205(or 218)"
  128.      would occur when the user tried to open an existing document. 
  129.  
  130. 3)   If Textcraft and its support files were moved into a sub- 
  131.      directory of a hard disk the message: 
  132.  
  133.      "Cannot open :Textcraft.  Error 205(or 218)"
  134.      would occur when the user tried to open an existing document. 
  135.  
  136.      The introduction manual should tell the user to use extend  
  137.      select or use info to change the default tool when this happens. 
  138.        
  139.      Any new documents would set the default tool to: 
  140.  
  141.        "HD_Name:/editors/textcraft_dir/textcraft" 
  142.             -- or -- 
  143.        ":/editors/textcraft_dir/textcraft" 
  144.        
  145. 4)   Running a spelling program: Extend-selecting will be
  146.      required unless and until the user changes the default tool. 
  147.  
  148.